Validator health status #3207

viquezclaudio · 2024-12-18T21:58:17Z

The validator health is used to track the overall validator health based on the number of consecutive deactivations of a validator on a per epoch basis.

The number of consecutive deactivations would cause a delay in terms of when the reactivation transaction is sent.

Pull request checklist

All tests pass. The project builds and runs.
I have resolved any merge conflicts.
I have resolved all clippy and rustfmt warnings.

Eligioo · 2025-01-09T11:01:09Z

test-utils/src/validator.rs

@@ -113,7 +113,7 @@ where
        let (v, c) = build_validator(
            peer_ids[i],
            Address::from(&validator_keys[i]),
-            false,
+            true,


Make automatic_reactivate a fn param for build_validators so it doesn't influence other tests?

Eligioo · 2025-01-09T11:11:01Z

validator/src/validator.rs

+    /// The current validator health
+    pub health: ValidatorHealth,
+    /// Number of blocks that we have produced in time(without being inactivated)
+    pub blk_cnt: u32,


Suggested change

pub blk_cnt: u32,

pub block_counter: u32,

Eligioo · 2025-01-09T11:12:15Z

validator/src/micro.rs

@@ -181,6 +198,8 @@ impl<TValidatorNetwork: ValidatorNetwork + 'static> NextProduceMicroBlockEvent<T
                continue;
            }

+            self.health_state.write().blk_cnt += 1;


Suggested change

self.health_state.write().blk_cnt += 1;

self.health_state.write().blk_cnt.saturating_add(1);

Prevent overflow

Eligioo · 2025-01-09T11:14:58Z

validator/src/micro.rs

+                log::warn!(block = block.block_number(), "Not publishing block");
+                let event = ProduceMicroBlockEvent::MicroBlock;
+                break Some(Some(event));


Suggested change

log::warn!(block = block.block_number(), "Not publishing block");

let event = ProduceMicroBlockEvent::MicroBlock;

break Some(Some(event));

log::warn!(block = block.block_number(), "Not publishing block");

break Some(Some(ProduceMicroBlockEvent::MicroBlock));

Eligioo · 2025-01-09T11:20:11Z

validator/src/validator.rs

+    pub health: ValidatorHealth,
+    /// Number of blocks that we have produced in time(without being inactivated)
+    pub blk_cnt: u32,
+    /// For testing/debug purposes control wether produced blocks are published by the validator


Suggested change

/// For testing/debug purposes control wether produced blocks are published by the validator

/// For testing/debug purposes control whether produced blocks are published by the validator

Eligioo · 2025-01-09T12:47:25Z

validator/src/validator.rs

+pub struct HealthState {
+    /// The current validator health
+    pub health: ValidatorHealth,
+    /// Number of blocks that we have produced in time(without being inactivated)


Suggested change

/// Number of blocks that we have produced in time(without being inactivated)

/// Number of subsequent blocks that we have been produced without being inactivated

Eligioo · 2025-01-09T12:59:00Z

validator/src/validator.rs

+                                good_blocks = %self.health_state.read().blk_cnt,
+                                "Current validator health is yellow",
+                            );
+                            if self.health_state.read().blk_cnt >= VALIDATOR_HEALTH_THRESHOLD {


This logic doesn't seem to match with the original description: If the validator is Yellow and is not deactivated in a quarter of an epoch, we change its status to Green.

Eligioo · 2025-01-09T12:59:41Z

validator/src/validator.rs

+                                inactivated = red_block_number,
+                                "Current validator health is red",
+                            );
+                            if self.health_state.read().blk_cnt >= VALIDATOR_HEALTH_THRESHOLD {


This logic doesn't seem to match with the original description: If the validator is Red and is not deactivated in one epoch, we change its status to Yellow.

Eligioo · 2025-01-09T13:01:15Z

validator/src/validator.rs

+                        let validator_health = self.health_state.read().health;
+                        match validator_health {


Suggested change

let validator_health = self.health_state.read().health;

match validator_health {

match self.health_state.read().health {

Eligioo · 2025-01-09T13:03:49Z

validator/src/validator.rs

+                            }
+                            ValidatorHealth::Red(_) => {
+                                log::warn!(
+                                    "The validator needs human intervention, no automatic reactivate"


Suggested change

"The validator needs human intervention, no automatic reactivate"

"The validator needs human intervention, no automatic reactivation"

Eligioo · 2025-01-30T08:48:39Z

validator/src/health.rs

+    }
+
+    /// This flag should only be used in tests context.
+    pub fn _set_publish_flag(&mut self, publish: bool) {


The method can be annotated with #[cfg(test)] such that it's only included in cargo test and not in cargo build.

Eligioo · 2025-01-31T09:53:18Z

primitives/account/src/account/staking_contract/validator.rs

@@ -46,6 +46,9 @@ use crate::{
 ///      in the first place.
 /// (**) The validator may be set to automatically reactivate itself upon inactivation.
 ///      If this setting is not enabled the state change can only be triggered manually.
+///      However, there is a delay incurred if the validator is deactivated multiple consecutive times
+///      in the current epoch. The delay is function of the number of deactivations and is reduced


Suggested change

/// in the current epoch. The delay is function of the number of deactivations and is reduced

/// in the current epoch. The delay is a function of the number of deactivations and is reduced

Eligioo · 2025-01-31T09:56:24Z

validator/src/health.rs

+
+use nimiq_keys::Address;
+
+/// Struct that represents the overall health of a validator


ValidatorHealthState is an enum not a struct

Eligioo · 2025-01-31T09:57:11Z

validator/src/health.rs

+    address: Address,
+    /// Only used for testing purposes controls whether blocks are published by the validator
+    publish: bool,
+    /// Number of consecutive inactivations that have ocurred in the current epoch


Suggested change

/// Number of consecutive inactivations that have ocurred in the current epoch

/// Number of consecutive inactivations that have occurred in the current epoch

Eligioo · 2025-01-31T10:00:02Z

validator/src/health.rs

+    publish: bool,
+    /// Number of consecutive inactivations that have ocurred in the current epoch
+    inactivations: u32,
+    /// Next block number where the re-activate transaction should be sent


Suggested change

/// Next block number where the re-activate transaction should be sent

/// Next block number indicating when the re-activate transaction should be sent

Eligioo · 2025-01-31T10:17:47Z

validator/src/micro.rs

@@ -181,6 +196,9 @@ impl<TValidatorNetwork: ValidatorNetwork + 'static> NextProduceMicroBlockEvent<T
                continue;
            }

+            // Each successfull block will decrease the number of inactivations


Suggested change

// Each successfull block will decrease the number of inactivations

// Each successful block will decrease the number of inactivations

Eligioo · 2025-01-31T10:21:53Z

validator/src/health.rs

+    /// Increases the number of consecutive deactivations
+    pub fn inactivate(&mut self, block_number: u32) {
+        if !self.pending_reactivate {
+            self.inactivations += 1;


saturating add?

Eligioo · 2025-01-31T10:27:04Z

validator/tests/mock.rs

@@ -15,7 +15,7 @@ use nimiq_network_interface::{
 };
 use nimiq_network_libp2p::Network;
 use nimiq_network_mock::{MockHub, MockNetwork};
-use nimiq_primitives::{networks::NetworkId, policy::Policy};
+use nimiq_primitives::{coin::Coin, networks::NetworkId, policy::Policy};


Unused imports?

Eligioo · 2025-01-31T10:27:09Z

validator/tests/mock.rs

@@ -24,9 +24,11 @@ use nimiq_test_utils::{
    },
 };
 use nimiq_time::{sleep, timeout};
+use nimiq_transaction_builder::TransactionBuilder;


Same as above

Eligioo · 2025-01-31T10:33:31Z

validator/tests/mock.rs

+        .write()
+        ._set_publish_flag(false);
+
+    events.take(30).for_each(|_| future::ready(())).await;


I guess you can take 50 here and get in the red state immediately. Testing if the validator got the yellow status is already covered in another test.

Track the number of blocks that are succesfully produced when changing the validator health

When a validator is deactivated, the reactivate transaction will have a delay based on the number of consecutive deactivations the validator has experienced in the current epoch. The amount of delayed blocks is of quadratic nature

viquezclaudio force-pushed the viquezcl/validator branch 2 times, most recently from f08b8d3 to 8108a5b Compare December 23, 2024 15:18

viquezclaudio force-pushed the viquezcl/validator branch from 6978477 to 124258f Compare December 26, 2024 17:37

viquezclaudio marked this pull request as ready for review December 26, 2024 17:37

Eligioo reviewed Jan 9, 2025

View reviewed changes

viquezclaudio added the WIP This pull request is still work in progress label Jan 13, 2025

viquezclaudio force-pushed the viquezcl/validator branch 2 times, most recently from 4bfe5c1 to cccd5e5 Compare January 14, 2025 19:44

viquezclaudio removed the WIP This pull request is still work in progress label Jan 14, 2025

viquezclaudio force-pushed the viquezcl/validator branch 2 times, most recently from 60bc95c to 0341c37 Compare January 28, 2025 21:05

viquezclaudio added the WIP This pull request is still work in progress label Jan 28, 2025

viquezclaudio force-pushed the viquezcl/validator branch 4 times, most recently from 8fb7bd7 to 28c51c2 Compare January 30, 2025 17:12

viquezclaudio removed the WIP This pull request is still work in progress label Jan 30, 2025

Eligioo reviewed Jan 31, 2025

View reviewed changes

viquezclaudio force-pushed the viquezcl/validator branch 2 times, most recently from 8955533 to 090ee97 Compare January 31, 2025 21:42

viquezclaudio added 3 commits February 5, 2025 09:57

Validator health status

6328152

Track blocks that are produced by validator

bc57e21

Track the number of blocks that are succesfully produced when changing the validator health

viquezclaudio force-pushed the viquezcl/validator branch from 090ee97 to 265abb1 Compare February 5, 2025 16:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Validator health status #3207

Validator health status #3207

viquezclaudio commented Dec 18, 2024 •

edited

Loading

Eligioo Jan 9, 2025

Eligioo Jan 9, 2025

Eligioo Jan 9, 2025

Eligioo Jan 9, 2025

Eligioo Jan 9, 2025

Eligioo Jan 9, 2025

Eligioo Jan 9, 2025

Eligioo Jan 9, 2025

Eligioo Jan 9, 2025

Eligioo Jan 9, 2025

Eligioo Jan 30, 2025

Eligioo Jan 31, 2025

Eligioo Jan 31, 2025

Eligioo Jan 31, 2025

Eligioo Jan 31, 2025

Eligioo Jan 31, 2025

Eligioo Jan 31, 2025

Eligioo Jan 31, 2025

Eligioo Jan 31, 2025

Eligioo Jan 31, 2025

	self.health_state.write().blk_cnt += 1;
	self.health_state.write().blk_cnt.saturating_add(1);

	/// For testing/debug purposes control wether produced blocks are published by the validator
	/// For testing/debug purposes control whether produced blocks are published by the validator

	/// Number of blocks that we have produced in time(without being inactivated)
	/// Number of subsequent blocks that we have been produced without being inactivated

		let validator_health = self.health_state.read().health;
		match validator_health {

	let validator_health = self.health_state.read().health;
	match validator_health {
	match self.health_state.read().health {

	"The validator needs human intervention, no automatic reactivate"
	"The validator needs human intervention, no automatic reactivation"

	/// in the current epoch. The delay is function of the number of deactivations and is reduced
	/// in the current epoch. The delay is a function of the number of deactivations and is reduced


		use nimiq_keys::Address;

		/// Struct that represents the overall health of a validator

	/// Number of consecutive inactivations that have ocurred in the current epoch
	/// Number of consecutive inactivations that have occurred in the current epoch

	/// Next block number where the re-activate transaction should be sent
	/// Next block number indicating when the re-activate transaction should be sent

	// Each successfull block will decrease the number of inactivations
	// Each successful block will decrease the number of inactivations

Validator health status #3207

Are you sure you want to change the base?

Validator health status #3207

Conversation

viquezclaudio commented Dec 18, 2024 • edited Loading

Pull request checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

viquezclaudio commented Dec 18, 2024 •

edited

Loading